<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>IDA SDK: source_file_t Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">IDA SDK
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="files.html"><span>Header&#160;Files</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classsource__file__t-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">source_file_t Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__dbg__funcs.html">Debugger functions</a> &raquo; <a class="el" href="group__dbg__funcs__srcinfo.html">Source information providers</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Describes a source file. </p>
</div>
<p>Inherits <a class="el" href="classqrefcnt__obj__t.html">qrefcnt_obj_t</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae766f902e9b535713905fd2aa83defa4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae766f902e9b535713905fd2aa83defa4"></a>
virtual void <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsource__file__t.html#ae766f902e9b535713905fd2aa83defa4">release</a> ()=0</td></tr>
<tr class="memdesc:ae766f902e9b535713905fd2aa83defa4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call this function to free <a class="el" href="classsource__file__t.html" title="Describes a source file. ">source_file_t</a>. <br /></td></tr>
<tr class="separator:ae766f902e9b535713905fd2aa83defa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf860e1e4f80e5e51fa0c07d69cbc970"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classsrcinfo__provider__t.html">srcinfo_provider_t</a> *<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsource__file__t.html#aaf860e1e4f80e5e51fa0c07d69cbc970">get_provider</a> (void) const  =0</td></tr>
<tr class="memdesc:aaf860e1e4f80e5e51fa0c07d69cbc970"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get source info provider.  <a href="#aaf860e1e4f80e5e51fa0c07d69cbc970">More...</a><br /></td></tr>
<tr class="separator:aaf860e1e4f80e5e51fa0c07d69cbc970"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1455b7602d82a7eee74a932e6023295f"><td class="memItemLeft" align="right" valign="top">virtual const char *<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsource__file__t.html#a1455b7602d82a7eee74a932e6023295f">get_path</a> (<a class="el" href="pro_8h.html#a386c10c6aa4340f1d63df85f40454fce">qstring</a> *errbuf)=0</td></tr>
<tr class="memdesc:a1455b7602d82a7eee74a932e6023295f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get path to the source file (or a symbolic name).  <a href="#a1455b7602d82a7eee74a932e6023295f">More...</a><br /></td></tr>
<tr class="separator:a1455b7602d82a7eee74a932e6023295f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00a610590cea98988b7f589ecc3ebae0"><td class="memItemLeft" align="right" valign="top">virtual TWidget *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsource__file__t.html#a00a610590cea98988b7f589ecc3ebae0">open_srcview</a> (<a class="el" href="group__simpleline.html#gac893a23d04b0b0ddc10cc44f4f9f01e6">strvec_t</a> **strvec, TWidget **pview, int lnnum, int colnum)=0</td></tr>
<tr class="memdesc:a00a610590cea98988b7f589ecc3ebae0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open window with source code (optional function).  <a href="#a00a610590cea98988b7f589ecc3ebae0">More...</a><br /></td></tr>
<tr class="separator:a00a610590cea98988b7f589ecc3ebae0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15a841c934a76d32a8fcccaabc1d9c9b"><td class="memItemLeft" align="right" valign="top">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsource__file__t.html#a15a841c934a76d32a8fcccaabc1d9c9b">read_file</a> (<a class="el" href="group__simpleline.html#gac893a23d04b0b0ddc10cc44f4f9f01e6">strvec_t</a> *buf, <a class="el" href="pro_8h.html#a386c10c6aa4340f1d63df85f40454fce">qstring</a> *errbuf)=0</td></tr>
<tr class="memdesc:a15a841c934a76d32a8fcccaabc1d9c9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read entire file (colored lines).  <a href="#a15a841c934a76d32a8fcccaabc1d9c9b">More...</a><br /></td></tr>
<tr class="separator:a15a841c934a76d32a8fcccaabc1d9c9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classqrefcnt__obj__t"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classqrefcnt__obj__t')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classqrefcnt__obj__t.html">qrefcnt_obj_t</a></td></tr>
<tr class="memitem:abca79ba34587bd7253077569aee4d137 inherit pub_methods_classqrefcnt__obj__t"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abca79ba34587bd7253077569aee4d137"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classqrefcnt__obj__t.html#abca79ba34587bd7253077569aee4d137">qrefcnt_obj_t</a> (void)</td></tr>
<tr class="memdesc:abca79ba34587bd7253077569aee4d137 inherit pub_methods_classqrefcnt__obj__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:abca79ba34587bd7253077569aee4d137 inherit pub_methods_classqrefcnt__obj__t"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_attribs_classqrefcnt__obj__t"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classqrefcnt__obj__t')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classqrefcnt__obj__t.html">qrefcnt_obj_t</a></td></tr>
<tr class="memitem:ab8d5e88bdc5903c5d918b6150c57f454 inherit pub_attribs_classqrefcnt__obj__t"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8d5e88bdc5903c5d918b6150c57f454"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classqrefcnt__obj__t.html#ab8d5e88bdc5903c5d918b6150c57f454">refcnt</a></td></tr>
<tr class="memdesc:ab8d5e88bdc5903c5d918b6150c57f454 inherit pub_attribs_classqrefcnt__obj__t"><td class="mdescLeft">&#160;</td><td class="mdescRight">counter <br /></td></tr>
<tr class="separator:ab8d5e88bdc5903c5d918b6150c57f454 inherit pub_attribs_classqrefcnt__obj__t"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aaf860e1e4f80e5e51fa0c07d69cbc970"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classsrcinfo__provider__t.html">srcinfo_provider_t</a>* <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> source_file_t::get_provider </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get source info provider. </p>
<p>There is no need to free or release it after using </p>

</div>
</div>
<a class="anchor" id="a1455b7602d82a7eee74a932e6023295f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> source_file_t::get_path </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="pro_8h.html#a386c10c6aa4340f1d63df85f40454fce">qstring</a> *&#160;</td>
          <td class="paramname"><em>errbuf</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get path to the source file (or a symbolic name). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">errbuf</td><td>pointer to buffer for the error message </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a00a610590cea98988b7f589ecc3ebae0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual TWidget* source_file_t::open_srcview </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__simpleline.html#gac893a23d04b0b0ddc10cc44f4f9f01e6">strvec_t</a> **&#160;</td>
          <td class="paramname"><em>strvec</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TWidget **&#160;</td>
          <td class="paramname"><em>pview</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>lnnum</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>colnum</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Open window with source code (optional function). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">strvec</td><td>pointer to source text. the text should not be destroyed until the form is closed </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pview</td><td>pointer to view that displays the source text (subview of TWidget) </td></tr>
    <tr><td class="paramdir"></td><td class="paramname">lnnum,colnum</td><td>cursor coordinates </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a15a841c934a76d32a8fcccaabc1d9c9b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool <a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> source_file_t::read_file </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__simpleline.html#gac893a23d04b0b0ddc10cc44f4f9f01e6">strvec_t</a> *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="pro_8h.html#a386c10c6aa4340f1d63df85f40454fce">qstring</a> *&#160;</td>
          <td class="paramname"><em>errbuf</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Read entire file (colored lines). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>pointer to output buffer </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">errbuf</td><td>pointer to buffer for the error message </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="dbg_8hpp.html">dbg.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
